KIT User Guide:

  1. What is KIT about?
  2. Quick Start
  3. Features
  4. FAQ
  5. Command Summary

1. What is KIT about?

Welcome! We believe that like us, you have many tasks and just too little time to manage them, sort them, filter them or just keep them in order. Is there a solution? Yes!

It’s Keep It Tidy.

Or KIT.

KIT is a desktop app that helps users manage their tasks and it is the one and only taskmanager you will ever need. With a simplistic design of UI and powerful functionalies embedded, KIT is capable of executing your instructions swiftly. On top of that, KIT is keyboard friendly, thereby saving you the trouble of ever moving the mouse and clicking.

Now, let’s get you started!

2. Quick start

Downloading KIT

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

Having any Java 8 version is not enough.
This app will not work with earlier versions of Java 8

  1. Download the latest KIT.jar from here.
    >
  2. Copy the file to the folder you want to use as the home folder for KIT.

Starting KIT

  1. Double-click the file to start the app. The GUI should appear in a few seconds.

  2. (Optional) You can choose to login to your Google Calendar.

    After you have logged in, it looks something like this. >

    Or you can explore KIT without using Google Calendar at all, just read on!

Looks a little empty, no? Let’s try adding some tasks!

Typing commands

  1. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.
  2. Some example commands you can try:
  1. Refer to the Features section below for details of each command.

3. Features

Command Format > > * Words in UPPER_CASE are the parameters. > * Parameters in [SQUARE_BRACKETS] are optional. > * Parameters with ... after them can have multiple instances. > * Parameters can be in any order.

3.1.1 Viewing help : help

If you are not sure where to start, take a sneakpeek at the help sheet!

Format: help [COMMAND], h [COMMAND], man [COMMAND], manual [COMMAND]

Example:

3.1.2 Viewing quick overview of command formats : helpf

Format: helpformat, helpf, summary, hf

3.2 Adding a task: add

Now you are ready to start exploring KIT. Try adding a task!

Description: Adds a task to KIT. New tasks are not done by default.

Format: add NAME [r/REMARKS] [s/STARTDATE] [e/ENDDATE] [l/LOCATION] [t/TAG]...

Here are some examples:

Supported Date/Time formats:

KIT has an intelligent processer that interprets your phrases and sentences about time, date and deadline.

Here is a table of interpretation for your convenience.

Date Format Example KIT’s interpretation
Month/day 10/19 Oct 19 of the current year
Day Month 6 Apr Apr 6 of the current year
Month Day Apr 6 Apr 6 of the current year
Day of the Week Mon, Monday The upcoming Monday
Relative date Yesterday, today, tomorrow, two weeks from now Corresponding dates relative to today
Holidays New Year, Christmas The dates of the holiday of the current year

3.3.1 Listing of task: list

You can use the flexible list command to view tasks that match certain criteria.

Description: Shows a list of tasks in KIT depending on chosen criterion.

Format: list [CRITERION], ls [CRITERION], l [CRITERION]

Available Criteria

done : display the list of all tasks that are done. notdone or undone : display the list of all tasks that are not done. floating or float : display the list of all tasks that have no start date and no end date.

If no criterion is specified, all tasks will be listed.

Examples: * ls : display all task. * list done : display all done task. * l notdone : display all notdone task. * ls float : display all floating task.

3.3.2 Listing of all task under a tag: list tag

We shouldn’t mix personal life with work. KIT understands that.

If you want to see all tasks with a particular tag only, say work, you can use the list tag function.

Description: Shows a list of task by the specified tag.

Format: list tag TAGNAME, ls tag TAGNAME, l tag TAGNAME

Example:

list tag work

This displays all task with the tag work.

3.4 Marking a task as done: done

Congratulations on completing your first task!

Now that you have completed a task, you can mark it as done by using the done function.

Description: Marks the task at the specified INDEX as “Done”.

Format: done INDEX, d INDEX

Tip : You can use the list done or list command to see the tasks you have marked as done. Task with green names and a tick are done tasks.

3.5 Marking a task as undone: undone

More follow ups for your task? Need to resume a completed task?

You can easily mark it as “Not Done” again.

Description: Marks the task at the specified INDEX as “Not Done”.

Format: undone INDEX, notdone INDEX, ud INDEX, nd INDEX

Note: Repeated or multiple done or undone on the same task does not change it’s status, i.e. done an already done task does not change it’s status.

3.6 Deleting a task: delete

Don’t want the old tasks to take up all the space?

If you would like to remove a task from KIT, simply use the delete function.

Description: Deletes the task with specified index from KIT.

Format: delete INDEX

Examples:

3.7.1 Undoing a command: undo

Made a mistake? No worries.

You can retract it by using the undo command.

Description: Undo the last command.

Format: undo, uhoh

3.7.2 Redoing a command: redo

Along with undo comes redo.

Just in case you changed your mind, you can also reverse your undo by using the redo command.

Description: Redo the last undo.

Format: redo

Undo and Redo basically works similarly to the page back and page forward button in your browser.

3.8 Editing a task: edit

Schedules change all the time, and in KIT you can, too.

The edit command allows you to edit the details of a task.

Description: Edits an existing task in KIT.

Format: edit INDEX [NAME] [r/REMARKS] [s/STARTDATE] [e/ENDDATE] [l/LOCATION] [t/TAG]...

Examples:

3.9.1 Finding a task: find

Finding a task in a stack of tasks can be troublesome.

KIT has an efficient find command that can help. Use it along with any keyword or date you can recall that is related to that task.

Description: Finds task whose names or remark contains the given keywords.

Format: find KEYWORD [MORE_KEYWORDS], f KEYWORD [MORE_KEYWORDS]

Examples:

3.9.2 Finding with exact keyword(s):findexact

What if you want to search for something more specific?

findexact allows you to do that.

Description: Finds task that contains words that are full matches of all the keyword(s).

Format: findexact KEYWORD..., fexact KEYWORD..., finde KEYWORD..., fe KEYWORD...

3.10 Google Calendar.

KIT provides support for Google Calendar users.

To use Google Calendar with KIT, we first require your permission for access to your Google Calendar. Note: Google Calendar related commands requires the internet and a Google Calendar account to work.

3.10.1 Import events from Google Calendar: gg

Do you have to copy and paste your events from Google Calendar? Of course not!

You can import your google calendar with the getgoogle command.

Description: Add your upcoming Events from your Google Calendar to KIT.

Format: getgoogle, gg > >

3.10.2 Post Task to Google Calendar: pg

Similarly, you can keep Google Calendar updated with KIT.

With postgoogle, you are able to add a task from KIT as an Event to your Google Calendar. It also updates tasks that are added before.

Description: Add or update the specified task to your Google Calendar.

Format: postgoogle [INDEX], pg [INDEX]

3.10.3 Adding a task with smart add: smartadd

Typing prefixes is too troublesome? Try smartadd.

You can add a new event to both your calendar and KIT usingsmartadd. This command is flexible and allows you to add a task’s location and date details without using the prefixes.

Description: Flexibly adds a task without specifying prefixes for date and location to both KIT and your calendar.

Format: sa DESCRIPTION [r/REMARK] [t/TAG]…

Example:

Some tips for using the Smart Add command:

Note: KIT will give the best interpretation of the given description, however, this may not always be accurate, especially for ambiguous descriptions.

For example, sa Meeting at Wednesday Cafe.

In this case, either ‘Wednesday Cafe’ is the actual location and the date is not specified. Or, it could also be interpreted as meeting on Wednesday at ‘Cafe’.

If the input is ambiguous, we recommend you to use the add command to clearly specify the location, date and etc.

3.11 Clearing all task: clear

Need a clean slate to start over?

Just use clear.

Description: Clears all entries from KIT.

Format: clear

3.12 Exiting the program: exit

Completed your work already? Exit KIT to have a break!

Description: Exits the program.

Format: exit

3.13.1 Specifying save location: save

Want a little secrecy? You can always custom the saving location of the file.

You can do so using the save function.

Description: Specify location of save file.

Format: save PATHNAME

3.13.2 Saving the data

KIT saves your data automatically and saves you the trouble.

In KIT, you data are saved automatically after a change has been made. There is no need to save manually.

3.14 Loading your own data

Transferring you data? KIT’s got you covered.

load function can load your data from a specified location.

Description: Loads a file from the specified location.

Format: load PATHNAME

Note: The file you wish to load has to be a xml file. Be careful when manipulating the xml file, an invalid format will not be read.

3.15 Changing the appearance of KIT

If you want to have a bit more colors, KIT can do that too!

changetheme allows you to change the colors and appearances of KIT.

Description: Changes the theme of KIT to the requested theme.

Notice the above screenshot is of a default theme, and the one below is of a light theme.

Format: changetheme [THEMENAME] > >

3.16 Using shortcuts

Feeling lazy to type the whole commands? Use KIT’s shortcuts.

In KIT, we provide shortcuts which are activated with different keyboard combinations.

Description: Fills the command box with specific command.

Example format: Ctrl + Alt + A This will fill the command box with “add”.

4. FAQ

Q: Does KIT support Windows 10?
A: Yes! KIT works as long as you have Java version 1.8.0_60 or later.

Q: Will my tasks be saved after I close the application?
A: Yes. Your data is saved after every command, so you can safely exit KIT when you are done. There is not need to manually save your data.

Q: Can I have two tasks with the same name?
A: Sure, tasks with same names are allowed, as long as at least one of their fields is different. That being said, tasks with completely same details are not allowed. Completely same details refer to same name, location, start date, end date and remark.

Q: I accidentally created two exact same tasks, how do I remove just one of them?
A: If you just added the task,meaning the most recent command is the add command, you can do so by typing undo. Otherwise, you can use find or list to search for the duplicate tasks and delete one of them. The other task will remain in KIT. Instructions on these commands can be found in the respective section of the commands.

Q: Can I manually edit the storage file?
A: Yes, you can. It is a xml file called kit.xml. It can be found under data.xml by default. Be careful in making changes to it if you are unfamiliar with XML, KIT will not be able to read your data if the format is invalid and will start with an empty KIT.

Q: I use two computers. Can I transfer my data between the two computers?
A: Yes, you can! Your data are saved in a file called kit.xml. Just copy this file to your computer and place in under data.xml. You can change the file location later using the save command.

Q: It’s troublesome to constantly transfer my data between two computers, is there any way for it to synchronize automatically?
A: Sorry, we currently do not support automatical synchronization. However, if you are using Dropbox, you can specify folders that will automatically synchronize through Dropbox. This means that you can use the save command to specify your save location in your Dropbox folder and thus get synchronization.

5. Command Summary